

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>WandbLogger &mdash; PackNet-SfM 1.0 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/language_data.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Geometry" href="../geometry/geometry.html" />
    <link rel="prev" title="Loggers" href="loggers.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../configs/configs.html">Configs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../scripts/scripts.html">Scripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../trainers/trainers.html">Trainers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../datasets/datasets.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../models/models.html">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../networks/networks.html">Networks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../losses/losses.html">Losses</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="loggers.html">Loggers</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">WandbLogger</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../geometry/geometry.html">Geometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="../utils/utils.html">Utils</a></li>
</ul>
<p class="caption"><span class="caption-text">Contact</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://tri.global">Toyota Research Institute</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/TRI-ML/packnet-sfm">PackNet-SfM GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/TRI-ML/DDAD">DDAD GitHub</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">PackNet-SfM</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="loggers.html">Loggers</a> &raquo;</li>
        
      <li>WandbLogger</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/loggers/loggers.WandbLogger.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="module-packnet_sfm.loggers.WandbLogger">
<span id="wandblogger"></span><h1>WandbLogger</h1>
<p>Wandb logger class to monitor training.</p>
<dl class="field-list simple">
<dt class="field-odd">param name</dt>
<dd class="field-odd"><p>Run name (if empty, uses a fancy Wandb name, highly recommended)</p>
</dd>
<dt class="field-even">type name</dt>
<dd class="field-even"><p>str</p>
</dd>
<dt class="field-odd">param dir</dt>
<dd class="field-odd"><p>Folder where wandb information is stored</p>
</dd>
<dt class="field-even">type dir</dt>
<dd class="field-even"><p>str</p>
</dd>
<dt class="field-odd">param id</dt>
<dd class="field-odd"><p>ID for the run</p>
</dd>
<dt class="field-even">type id</dt>
<dd class="field-even"><p>str</p>
</dd>
<dt class="field-odd">param anonymous</dt>
<dd class="field-odd"><p>Anonymous mode</p>
</dd>
<dt class="field-even">type anonymous</dt>
<dd class="field-even"><p>bool</p>
</dd>
<dt class="field-odd">param version</dt>
<dd class="field-odd"><p>Run version</p>
</dd>
<dt class="field-even">type version</dt>
<dd class="field-even"><p>str</p>
</dd>
<dt class="field-odd">param project</dt>
<dd class="field-odd"><p>Wandb project where the run will live</p>
</dd>
<dt class="field-even">type project</dt>
<dd class="field-even"><p>str</p>
</dd>
<dt class="field-odd">param tags</dt>
<dd class="field-odd"><p>List of tags to append to the run</p>
</dd>
<dt class="field-even">type tags</dt>
<dd class="field-even"><p>list of str</p>
</dd>
<dt class="field-odd">param log_model</dt>
<dd class="field-odd"><p>Log the model to wandb or not</p>
</dd>
<dt class="field-even">type log_model</dt>
<dd class="field-even"><p>bool</p>
</dd>
<dt class="field-odd">param experiment</dt>
<dd class="field-odd"><p>Wandb experiment</p>
</dd>
<dt class="field-even">type experiment</dt>
<dd class="field-even"><p>wandb</p>
</dd>
<dt class="field-odd">param entity</dt>
<dd class="field-odd"><p>Wandb entity</p>
</dd>
<dt class="field-even">type entity</dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="packnet_sfm.loggers.WandbLogger.experiment">
<code class="sig-prename descclassname">packnet_sfm.loggers.WandbLogger.</code><code class="sig-name descname">experiment</code></dt>
<dd><p>Returns the experiment (creates a new if it doesn’t exist).</p>
</dd></dl>

<dl class="py attribute">
<dt id="packnet_sfm.loggers.WandbLogger.name">
<code class="sig-prename descclassname">packnet_sfm.loggers.WandbLogger.</code><code class="sig-name descname">name</code></dt>
<dd><p>Returns experiment name.</p>
</dd></dl>

<dl class="py attribute">
<dt id="packnet_sfm.loggers.WandbLogger.run_name">
<code class="sig-prename descclassname">packnet_sfm.loggers.WandbLogger.</code><code class="sig-name descname">run_name</code></dt>
<dd><p>Returns run name.</p>
</dd></dl>

<dl class="py attribute">
<dt id="packnet_sfm.loggers.WandbLogger.run_url">
<code class="sig-prename descclassname">packnet_sfm.loggers.WandbLogger.</code><code class="sig-name descname">run_url</code></dt>
<dd><p>Returns run URL.</p>
</dd></dl>

<dl class="py attribute">
<dt id="packnet_sfm.loggers.WandbLogger.version">
<code class="sig-prename descclassname">packnet_sfm.loggers.WandbLogger.</code><code class="sig-name descname">version</code></dt>
<dd><p>Returns experiment version.</p>
</dd></dl>

</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../geometry/geometry.html" class="btn btn-neutral float-right" title="Geometry" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="loggers.html" class="btn btn-neutral float-left" title="Loggers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Toyota Research Institute (TRI)

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(false);
      });
  </script>

  
  
    
   

</body>
</html>